[beta] Start a Function run.

Start an asynchronous run for the specified Function. This endpoint allows you to override parameters available at runtime.

Rate limit: 2 requests/min (learn more about rate limits here).

To use this endpoint, select Write Functions under the Functions category when creating or editing an API token. Learn More.

Submit Feedback: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team.

POST /functions/{name}/runs

[beta] Start a Function run.

cURL

curl --request POST \
  --url https://api.samsara.com/functions/{name}/runs \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "paramsOverride": {
    "param1": "value1",
    "param2": "value2"
  }
}
'

200

{
  "data": {
    "correlationId": "550e8400-e29b-41d4-a716-446655440000"
  }
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

name · string · required

The name of the Function to run.

Body

application/json

Request body for starting a Function run.

paramsOverride · object · required

Parameter overrides for the Function execution. Can be an empty object but must be provided.

Example:

{ "param1": "value1", "param2": "value2" }

Response

200

application/json

OK response.

data · object · required

Response body after successfully starting a Function run.

Show child attributes